docs: enable feature tagging #2395
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
camshaft
reviewed
Dec 3, 2024
quic/s2n-quic/Cargo.toml
Outdated
| # Compile with the `s2n_docsrs` feature to enable feature tagging in rust docs. See | ||
| # documentation for additional configuration options: https://docs.rs/about/metadata | ||
| [package.metadata.docs.rs] | ||
| rustdoc-args = ["--cfg", "s2n_docsrs"] |
There was a problem hiding this comment.
Is there a reason we need our own? Why not just use the one docs.rs already sets?
There was a problem hiding this comment.
Yea I wasn't sure if that was something that docsrs set or if tokio didnt namespace the cfg flag. Lemme try and find docs mentioning that and/or test it on my test crate
There was a problem hiding this comment.
So actually are you certain that gets set by docsrs? Tokio also sets rustdoc-args which specifies docsrs.
camshaft
reviewed
Dec 3, 2024
camshaft
approved these changes
Dec 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolved issues:
#1831
Description of changes:
This PR enables feature tagging in our rust docs. This is useful for customers that want to use enable APIs that require building s2n-quic with certain features.
Call-outs:
This PR only covers the main s2n-quic crate. Future work might be to expand feature tagging to other s2n-quic crates.
We need to gate the feature on
docsrssince it requires nightly cargo and would otherwise break stable builds.We rely
doc_auto_cfgto auto generate the feature tagging where applicable. However, we also require manually tagging withdoc_cfgcfg_if!macroTesting:
The example report in CI shows the feature tagging.
I also tested this on a personal test crate to verify crates.io works as intended.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.